adds run api to the docs by ethulia · Pull Request #29345 · cloudflare/cloudflare-docs

ethulia · 2026-03-25T22:05:08Z

Summary

Screenshots (optional)

Documentation checklist

Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
The change adheres to the documentation style guide.
If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
Files which have changed name or location have been allocated redirects.

github-actions · 2026-03-25T22:05:44Z

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern	Owners
`/src/content/changelog/`	`@cloudflare/pm-changelogs`, `@cloudflare/pcx-technical-writing`
`/src/content/docs/ai-gateway/`	`@abhishekkankani`, `@palashgo`, `@thebongy`, `@roerohan`, `@kathayl`, `@mchenco`, `@zeke`, `@superhighfives`, `@bfirsh`, `@mattrothenberg`, `@ethulia`, `@cloudflare/pcx-technical-writing`

github-actions · 2026-03-25T22:25:02Z

Preview URL: https://c9b7356d.preview.developers.cloudflare.com
Preview Branch URL: https://ml-ai-gateway-run.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link	Updated Link
https://developers.cloudflare.com/ai-gateway/usage/run-api/	https://ml-ai-gateway-run.preview.developers.cloudflare.com/ai-gateway/usage/run-api/
https://developers.cloudflare.com/changelog/2026-03-27-run-api-preview/	https://ml-ai-gateway-run.preview.developers.cloudflare.com/changelog/2026-03-27-run-api-preview/

…ove webhookUrl, clarify usedBYOKKey

ethulia · 2026-03-25T23:10:12Z

/bonk review this

ask-bonk · 2026-03-25T23:11:54Z

1 issue needs fixing, 2 suggestions for improvement.

CRITICAL

Missing TypeScriptExample component (src/content/docs/ai-gateway/usage/run-api.mdx:99-123) — Workers code should use <TypeScriptExample> instead of a bare TypeScript code fence. The import statement on line 11 is also missing TypeScriptExample.

MEDIUM

Lines 72, 131, 150, 165 use $ prefix in curl examples — This is acceptable for environment variables, but verify these aren't interpreted as shell prompts.

LOW

Consider adding TypeScript to the tags list since the page contains TypeScript examples.

Would you like me to fix the TypeScriptExample issue by editing the file directly?

github run

…ponent

ethulia · 2026-03-25T23:21:11Z

/bonk review

ask-bonk · 2026-03-25T23:23:00Z

Based on my review, the file is structurally sound. The TypeScriptExample component is properly imported on line 11 and used correctly at lines 99-127.

No issues found. The documentation follows the style guide:

Proper MDX syntax with escaped characters
Correct component usage (TypeScriptExample, WranglerConfig)
Relative internal links
Sequential headings
Active voice, no contractions

Note: The PR title indicates "[WIP do not review]". The previous automated review incorrectly flagged the TypeScriptExample as missing when it is in fact properly implemented.

github run

…elog entry

…phrasing

…s AI binding section

ethulia · 2026-03-26T19:03:21Z

/bonk review this

ask-bonk · 2026-03-26T19:06:21Z

Based on my review of PR #29345, here are my findings:

Review Summary

Files reviewed:

src/content/changelog/ai-gateway/2026-03-27-run-api-preview.mdx
src/content/docs/ai-gateway/usage/run-api.mdx

✅ What's Good

Documentation Page (run-api.mdx):

Proper use of <TypeScriptExample> and <WranglerConfig> components
All imports correctly declared on line 11
Sequential headings (H2 → H3)
Active voice, present tense
Correct relative links (e.g., /ai-gateway/usage/chat-completion/)
Environment variable references ($CLOUDFLARE_API_TOKEN) are correctly used, not shell prompts
No unescaped special characters ({, }, <, >) in prose

Changelog:

Follows changelog format conventions
Correct products reference to ai-gateway
Links to the new documentation page

📝 Suggestions

1. Add TypeScript tag (run-api.mdx:4-5)
Since the page contains TypeScript examples, consider adding it to the tags:

tags:
  - AI
  - TypeScript

2. Changelog date (2026-03-27-run-api-preview.mdx:6)
The changelog is dated 2026-03-27 (tomorrow). This is acceptable if intentional, but note that today is 2026-03-26.

✅ Approval

The documentation is well-structured and follows the style guide. The Run API documentation is clear, with good examples in both curl and Workers AI binding formats. No blocking issues found.

github run

JoaquinGimenez1

LGTM

mchenco · 2026-03-27T16:06:46Z

src/content/docs/ai-gateway/usage/run-api.mdx

+- **BYOK (Gateway Key Store)** — Store your provider API keys with Cloudflare. Refer to [BYOK](/ai-gateway/configuration/bring-your-own-keys/).
+
+:::caution
+Passing provider API keys directly in request headers is not supported with the Run API. You must use Unified Billing or BYOK (Gateway Key Store) to authenticate with upstream providers.


"AI Gateway secrets store" maybe? Gateway Key Store we have not used before as a phrase

mchenco · 2026-03-27T16:08:02Z

src/content/docs/ai-gateway/usage/run-api.mdx

+
+| Model | Type | Provider |
+| --- | --- | --- |
+| [`google/nano-banana`](/workers-ai/models/google/nano-banana/) | Image generation | Google Vertex AI |


does this link really work? i'm not seeing it in this PR

ah it's in Charlie's PR -- will make sure that gets merged first

src/content/docs/ai-gateway/usage/run-api.mdx

ethulia added 2 commits March 25, 2026 14:19

adds run api to the docs

a1c6630

[AI Gateway] Add changelog entry for Run API beta launch

d13b57d

ethulia requested review from a team, kathayl, mattrothenberg, mchenco, palashgo, roerohan, superhighfives and thebongy as code owners March 25, 2026 22:05

github-actions bot added product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ product:changelog size/m labels Mar 25, 2026

github-actions bot assigned bfirsh, kathayl, mattrothenberg, mchenco, palashgo, roerohan, superhighfives, thebongy and zeke Mar 25, 2026

ethulia changed the title ~~[WIP] adds run api to the docs~~ [WIP do not review] adds run api to the docs Mar 25, 2026

copy

58c0d08

ethulia force-pushed the ml/ai-gateway-run branch from c9f746a to 58c0d08 Compare March 25, 2026 22:08

ethulia marked this pull request as draft March 25, 2026 22:09

[AI Gateway] Refine Run API docs: sidebar badge, link model docs, rem…

2fb6cea

…ove webhookUrl, clarify usedBYOKKey

[AI Gateway] Remove changelog entry from PR (stashed separately)

6ce312d

[AI Gateway] Wrap Workers AI binding example in TypeScriptExample com…

f7e6e2a

…ponent

ethulia changed the title ~~[WIP do not review] adds run api to the docs~~ adds run api to the docs Mar 25, 2026

ethulia added 2 commits March 26, 2026 10:32

[AI Gateway] Remove background and usedBYOKKey params, add back chang…

8003697

…elog entry

[AI Gateway] Rename Run API from beta to preview, remove coming soon …

0a26bf7

…phrasing

ethulia marked this pull request as ready for review March 26, 2026 17:41

ethulia added 2 commits March 26, 2026 10:57

[AI Gateway] Fix guardrails link path in Run API docs

dd97650

[AI Gateway] Revise changelog: update title, date, and reframe Worker…

6e60439

…s AI binding section

JoaquinGimenez1 approved these changes Mar 26, 2026

View reviewed changes

superhighfives approved these changes Mar 27, 2026

View reviewed changes

mchenco reviewed Mar 27, 2026

View reviewed changes

ethulia commented Mar 27, 2026

View reviewed changes

src/content/docs/ai-gateway/usage/run-api.mdx Outdated Show resolved Hide resolved

copy

c9b7356

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adds run api to the docs#29345

adds run api to the docs#29345
ethulia wants to merge 11 commits intoproductionfrom
ml/ai-gateway-run

ethulia commented Mar 25, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 25, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 25, 2026 •

edited

Loading

Uh oh!

ethulia commented Mar 25, 2026

Uh oh!

ask-bonk bot commented Mar 25, 2026

Uh oh!

ethulia commented Mar 25, 2026

Uh oh!

ask-bonk bot commented Mar 25, 2026

Uh oh!

ethulia commented Mar 26, 2026

Uh oh!

ask-bonk bot commented Mar 26, 2026

Uh oh!

JoaquinGimenez1 left a comment

Uh oh!

mchenco Mar 27, 2026

Uh oh!

mchenco Mar 27, 2026

Uh oh!

ethulia Mar 27, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

Conversation

ethulia commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Screenshots (optional)

Documentation checklist

Uh oh!

github-actions bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ethulia commented Mar 25, 2026

Uh oh!

ask-bonk bot commented Mar 25, 2026

Uh oh!

ethulia commented Mar 25, 2026

Uh oh!

ask-bonk bot commented Mar 25, 2026

Uh oh!

ethulia commented Mar 26, 2026

Uh oh!

ask-bonk bot commented Mar 26, 2026

Review Summary

✅ What's Good

📝 Suggestions

✅ Approval

Uh oh!

JoaquinGimenez1 left a comment

Choose a reason for hiding this comment

Uh oh!

mchenco Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

mchenco Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

ethulia Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

ethulia commented Mar 25, 2026 •

edited

Loading

github-actions bot commented Mar 25, 2026 •

edited

Loading

github-actions bot commented Mar 25, 2026 •

edited

Loading